Move EraBasedProtocolParametersUpdate to Cardano.Api.Compatible.ProtocolParametersUpdate by Jimbo4350 · Pull Request #1336 · IntersectMBO/cardano-api

Jimbo4350 · 2026-09-10T16:49:15Z

Changelog

- description: |
    Move `EraBasedProtocolParametersUpdate`, its era-sliced record types and the pre-Conway `UpdateProposal` machinery into a new module `Cardano.Api.Compatible.ProtocolParametersUpdate`. `Cardano.Api.ProtocolParameters` re-exports it, so its export list is unchanged.
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
   - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...
# uncomment at least one main project this PR is associated with
  projects:
   - cardano-api
  # - cardano-api-gen
  # - cardano-rpc
  # - cardano-wasm

Context

Follow-up to #1335 (stacked on it). Moves the era-based update-proposal machinery out of Cardano.Api.ProtocolParameters into Cardano.Api.Compatible.ProtocolParametersUpdate: EraBasedProtocolParametersUpdate, its era-sliced records, createEraBasedProtocolParamUpdate, createPParams, UpdateProposal and its to/fromLedger* conversions. The UpdateProposal cluster must move with the GADT: it contains it, and the GADT's FromCBOR instance depends on fromLedgerPParamsUpdate, which uses the private slice helpers.

Cardano.Api.ProtocolParameters re-exports the new module, so its export list and Cardano.Api are unchanged. Cardano.Api.Compatible re-exports it too.

How to trust this PR

Pure code motion plus import/export plumbing; no function bodies changed.
The export list of Cardano.Api.ProtocolParameters is identical to master.
cabal build cardano-api --enable-tests is clean under -Werror.

Checklist

Commit sequence broadly makes sense and commits have useful messages
New tests are added if needed and existing tests are updated. See Running tests for more details
Self-reviewed the diff

🤖 Generated with Claude Code

+{-# LANGUAGE ConstraintKinds #-}
+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveDataTypeable #-}


+{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}


+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}


+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
+{-# LANGUAGE LambdaCase #-}


+{-# LANGUAGE GADTs #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
+{-# LANGUAGE LambdaCase #-}
+{-# LANGUAGE NamedFieldPuns #-}


palas

Looks good 👍. (Just code moving from one module to another.)

One question

palas · 2026-09-11T14:53:29Z

+    -- * Data family instances
+  , AsType (..)


Suggested change

-- * Data family instances

, AsType (..)

-- * Data family instances

, AsType (AsUpdateProposal)

Should we qualify this export? Apparently, it will export things like AsPaymentKey, AsWord8, and AsByteStringLazy, if we don't qualify it

…colParametersUpdate Relocates the era-based protocol parameter update GADT, its era-sliced record types, createEraBasedProtocolParamUpdate, createPParams and the pre-Conway UpdateProposal machinery into a new Compatible module. The UpdateProposal cluster has to move with the GADT: UpdateProposal contains it, and its FromCBOR instance depends on fromLedgerPParamsUpdate, which in turn uses the private pparamsUpdateTo* helpers. Cardano.Api.ProtocolParameters re-exports the new module, so its export list and Cardano.Api are unchanged. Cardano.Api.Compatible re-exports the new module as well.

AsType (..) on a data family re-exports every in-scope instance constructor, not just the one defined in this module.

Copilot

🟢 Approval recommended

No unresolved issues were identified, and existing exports are preserved.

Pull request overview

Moves era-based protocol parameter update machinery into a dedicated compatibility module while preserving existing exports.

Changes:

Added and re-exported ProtocolParametersUpdate.
Registered the new module in Cabal.
Added a refactoring changelog entry.

File summaries

File	Description
`cardano-api/src/Cardano/Api/ProtocolParameters.hs`	Re-exports the moved definitions.
`cardano-api/src/Cardano/Api/Compatible/ProtocolParametersUpdate.hs`	Contains the moved update machinery.
`cardano-api/src/Cardano/Api/Compatible.hs`	Re-exports the new module.
`cardano-api/cardano-api.cabal`	Exposes the new module.
`.changes/move-era-based-protocol-parameters-update.yml`	Documents the refactoring.

Review details

Files reviewed: 5/5 changed files
Comments generated: 0
Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Jimbo4350 requested review from CarlosLopezDeLara, carbolymer, disassembler, erikd and palas as code owners September 10, 2026 16:49

Jimbo4350 force-pushed the jordan/move-era-based-pparams-update branch from a4fad03 to 302fc0d Compare September 10, 2026 16:49

github-advanced-security Bot found potential problems Sep 10, 2026

View reviewed changes

Jimbo4350 force-pushed the jordan/move-era-based-pparams-update branch from 302fc0d to 1f1acd6 Compare September 10, 2026 17:58

Base automatically changed from jordan/remove-protocol-parameters to master September 10, 2026 18:37

palas approved these changes Sep 11, 2026

View reviewed changes

Copilot AI lite review requested due to automatic review settings September 11, 2026 15:54

Jimbo4350 added 2 commits September 11, 2026 11:55

Export only AsUpdateProposal instead of the whole AsType data family

74cd35b

AsType (..) on a data family re-exports every in-scope instance constructor, not just the one defined in this module.

Jimbo4350 force-pushed the jordan/move-era-based-pparams-update branch from fa282fb to 74cd35b Compare September 11, 2026 15:57

Jimbo4350 enabled auto-merge September 11, 2026 15:59

Copilot started reviewing on behalf of Jimbo4350 September 11, 2026 15:59 View session

Copilot AI reviewed Sep 11, 2026

View reviewed changes

Jimbo4350 added this pull request to the merge queue Sep 11, 2026

Merged via the queue into master with commit ab85f88 Sep 11, 2026
31 checks passed

Jimbo4350 deleted the jordan/move-era-based-pparams-update branch September 11, 2026 17:56

Navigation Menu

Uh oh!

Move EraBasedProtocolParametersUpdate to Cardano.Api.Compatible.ProtocolParametersUpdate - #1336

Move EraBasedProtocolParametersUpdate to Cardano.Api.Compatible.ProtocolParametersUpdate#1336
Jimbo4350 merged 2 commits into
masterfrom
jordan/move-era-based-pparams-update

Jimbo4350 commented Sep 10, 2026 •

edited

Loading

Uh oh!

palas left a comment

Uh oh!

palas Sep 11, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Jimbo4350 commented Sep 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Context

How to trust this PR

Checklist

Uh oh!

palas left a comment

Choose a reason for hiding this comment

Uh oh!

palas Sep 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟢 Approval recommended

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Jimbo4350 commented Sep 10, 2026 •

edited

Loading